[ruff] Avoid f-string false positives in gettext calls (RUF027)
#10118
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
robincaloudis
force-pushed
the
rc-fix-false-positive-translation-strings
branch
4 times, most recently
from
f75fb21
to
2f991a0
Compare
robincaloudis
force-pushed
the
rc-fix-false-positive-translation-strings
branch
from
2f991a0
to
f3156ad
Compare
|
| code | total | + violation | - violation | + fix | - fix |
|---|---|---|---|---|---|
| RUF027 | 4 | 0 | 4 | 0 | 0 |
|
Thank you! Will review. |
|
(The ecosystem checks look good.) |
| @@ -70,13 +70,38 @@ pub(crate) fn missing_fstring_syntax( | |||
| } | |||
| } | |||
|
|
|||
| // We also want to avoid expressions that are intended to be translated. | |||
| if semantic.current_expressions().any(is_gettext) { | |||
There was a problem hiding this comment.
I had to generalize this to look at all parent expressions, to catch cases like: print(_("formatting of {partial} in a translation string is bad practice"))
There was a problem hiding this comment.
Great additions! Thanks.
charliermarsh
force-pushed
the
rc-fix-false-positive-translation-strings
branch
from
be36cb0
to
f47f2eb
Compare
charliermarsh
changed the title
ruff] Avoid f-string false positives in gettext calls (RUF027)
charliermarsh
force-pushed
the
rc-fix-false-positive-translation-strings
branch
from
f47f2eb
to
17693ee
Compare
nkxxll
pushed a commit
to nkxxll/ruff
that referenced
this pull request
Mar 10, 2024
…astral-sh#10118) ## Summary It is a convention to use the `_()` alias for `gettext()`. We want to avoid statement expressions and assignments related to aliases of the gettext API. See https://docs.python.org/3/library/gettext.html for details. When one uses `_() to mark a string for translation, the tools look for these markers and replace the original string with its translated counterpart. If the string contains variable placeholders or formatting, it can complicate the translation process, lead to errors or incorrect translations. ## Test Plan * Test file `RUF027_1.py` was extended such that the test reproduces the false-positive Closes astral-sh#10023. --------- Co-authored-by: Charlie Marsh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
It is a convention to use the
_()alias forgettext(). We want to avoidstatement expressions and assignments related to aliases of the gettext API.
See https://docs.python.org/3/library/gettext.html for details. When one
uses `_() to mark a string for translation, the tools look for these markers
and replace the original string with its translated counterpart. If the
string contains variable placeholders or formatting, it can complicate the
translation process, lead to errors or incorrect translations.
Test Plan
RUF027_1.pywas extended such that the test reproduces the false-positiveCloses #10023.